/**
 * Copyright (c) 2010 C. Scott Grogan (scott@ninjascript.com)
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.ninjascript.tanooki;

import java.io.File;


/**
 * @author C. Scott Grogan
 * 
 * Tabuki is a format to format converter for tables of data.
 * 
 * Supports...
 *   
 * /==================================================\
 * | Format             | Convert From? | Convert To? |
 * |==================================================|
 * | CSV                | yes           | no          |
 * | XLS                | no            | no          |
 * | XML                | no            | no          |
 * | JSON               | no            | no          |
 * | java.sql.ResultSet | no            | no          |
 * \==================================================/
 * 
 * Usage: 
 * 
 *   Tabuki.transform(file|path|ResultSet).to(format);
 * 
 */
public class Tanooki {
	
	private TanookiTable table = null;
	private TanookiResult result = null;

	public Tanooki() {
		/** Constructor doesn't do anything, ok? */
	}
	
	/**
	 * Converts a file into an array of TabukiRow objects.
	 * @param somefile	A file; probably CSV.
	 * @return			An array of TabukiRow objects.
	 */
	public Tanooki transform(File somefile) throws Exception {
		Marshaller marshaller = MarshallerFactory.getInstance().createMarshallerFor(somefile);
		table = marshaller.marshal();
		return this;
	}
	
	/**
	 * Converts an array of TabukiRow objects into some format.
	 * @param someformat	The name of a format; probably JSON.
	 * @return				A TabukiCapsule object that contains the result and a format attr.
	 */
	public TanookiResult to(String someformat) {
		result = new TanookiResult();
		return result;
	}
	
	public TanookiTable getTable() {
		return table;
	}
	
	public TanookiResult getResult() {
		return result;
	}
	
}
